docs: update res.clearCookie documentation for clarity and accuracy #2000
+17
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sebastian Beltran <[email protected]>
✅ Deploy Preview for expressjscom-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This comment was marked as off-topic.
This comment was marked as off-topic.
bjohansebas
added
docs
This comment was marked as duplicate.
This comment was marked as duplicate.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve the message by expanding on how the cookie is cleared, and include a note about the deprecation of the
max-ageandexpiresoptions: in Express 4 they are still respected (not ignored), whereas in Express 5 they are ignored.ref: expressjs/express#5792
ref: expressjs/express#5640
ref: expressjs/express#5672
closes: #1146
Preview: https://deploy-preview-2000--expressjscom-preview.netlify.app/en/4x/api.html#res.clearCookie, https://deploy-preview-2000--expressjscom-preview.netlify.app/en/5x/api.html#res.clearCookie
Note: We need to manage changes more effectively. Whenever there are changes, and once they have been released, a PR should be opened here to update the documentation. Improving these processes will help us keep our documentation better maintained.
cc: @expressjs/express-collaborators @expressjs/docs-wg